Skip to content

improve cli documentation for questions#754

Merged
jreidinger merged 8 commits intomasterfrom
questions_documentation
Sep 18, 2023
Merged

improve cli documentation for questions#754
jreidinger merged 8 commits intomasterfrom
questions_documentation

Conversation

@jreidinger
Copy link
Copy Markdown
Contributor

@jreidinger jreidinger commented Sep 14, 2023

Problem

There is insufficient documentation of questions CLI.

Solution

Improve it

Testing

  • Tested manually

Screenshots

Before:

jreidinger@localhost:~/prace/yast/d-installer/rust/target/debug> ./agama questions --help
Questions handling

Usage: agama questions <COMMAND>

Commands:
  mode     Set mode for answering questions
  answers  
  help     Print this message or the help of the given subcommand(s)

Options:
  -h, --help  Print help



jreidinger@localhost:~/prace/yast/d-installer/rust/target/debug> ./agama questions mode --help
Set mode for answering questions

Usage: agama questions mode <VALUE>

Arguments:
  <VALUE>  [possible values: interactive, non-interactive]

Options:
  -h, --help  Print help



jreidinger@localhost:~/prace/yast/d-installer/rust/target/debug> ./agama questions answers --help
Usage: agama questions answers <PATH>

Arguments:
  <PATH>  

Options:
  -h, --help  Print help

After:

jreidinger@localhost:~/prace/yast/d-installer/rust/target/debug> ./agama questions --help
Configuration for questions that come from installer

Questions are raised when unexpected situation happen in Installer like if encrypted partition is detected and cannot be inspected, if repository is sign by unknown GPG key or if installer is not sure if multipath should be activated.

For more details see official agama documentation for Questions.

Usage: agama questions <COMMAND>

Commands:
  mode     Sets the mode for answering questions
  answers  Loads predefined answers to questions
  help     Print this message or the help of the given subcommand(s)

Options:
  -h, --help
          Print help (see a summary with '-h')



jreidinger@localhost:~/prace/yast/d-installer/rust/target/debug> ./agama questions mode --help
Sets the mode for answering questions.

It allows to decide if questions will be interactive or if it should not block installation.

Usage: agama questions mode <VALUE>

Arguments:
  <VALUE>
          [possible values: interactive, non-interactive]

Options:
  -h, --help
          Print help (see a summary with '-h')



jreidinger@localhost:~/prace/yast/d-installer/rust/target/debug> ./agama questions answers --help
Loads predefined answers to questions.

It allows to predefine answers for certain questions to skip them in interactive mode or change answer in automatic mode.

For more details and examples see official Agama documentation.

Usage: agama questions answers <PATH>

Arguments:
  <PATH>
          Local path to file with answers in YAML format

Options:
  -h, --help
          Print help (see a summary with '-h')

@coveralls
Copy link
Copy Markdown

coveralls commented Sep 15, 2023 •
edited
Loading

Coverage Status

coverage: 72.653% (+0.007%) from 72.646% when pulling 487e3a7 on questions_documentation into 5b3172e on master.

mvidner
mvidner reviewed Sep 15, 2023
View reviewed changes
rust/agama-cli/src/commands.rs Outdated
/// Questions handling
/// Configuration for questions that come from installer
///
/// Questions are raised when unexpected situation happen in Installer
Copy link
Copy Markdown
Contributor

@mvidner mvidner Sep 15, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
/// Questions are raised when unexpected situation happen in Installer
/// Questions are raised when an unexpected situation happens in the installer:

Copy link
Copy Markdown
Contributor

@mvidner mvidner Sep 15, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well unexpected is wrong. It is expected, that's why we have coded a special case for it

Copy link
Copy Markdown
Contributor Author

@jreidinger jreidinger Sep 15, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah, I am not sure what is better word. Maybe "uncommon" or "rare"? not sure

rust/agama-cli/src/questions.rs
/// It allows to predefine answers for certain questions to skip
/// them in interactive mode or change answer in automatic mode.
///
/// For more details and examples see official Agama documentation.
Copy link
Copy Markdown
Contributor

@mvidner mvidner Sep 15, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd like to have a more helpful reference here

Copy link
Copy Markdown
Contributor

@mvidner mvidner Sep 15, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://github.com/openSUSE/agama/blob/master/doc/questions.md or anything else?

Copy link
Copy Markdown
Contributor Author

@jreidinger jreidinger Sep 15, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is what I am not sure if it will be documented on official suse side or not..and if it will be product specific or not.

@jreidinger @mvidner
Apply suggestions from code review
b9a7e4c 
Co-authored-by: Martin Vidner <mvidner@suse.cz>
mvidner
mvidner reviewed Sep 18, 2023
View reviewed changes
mvidner
mvidner reviewed Sep 18, 2023
View reviewed changes
mvidner
mvidner approved these changes Sep 18, 2023
View reviewed changes
Copy link
Copy Markdown
Contributor

@mvidner mvidner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have put the remaining info into the comments

jreidinger and others added 2 commits September 18, 2023 11:45
@jreidinger @mvidner
Apply suggestions from code review
651ef17 
Co-authored-by: Martin Vidner <mvidner@suse.cz>
@jreidinger
make rust linter happy
487e3a7
@jreidinger jreidinger merged commit 7d0b821 into master Sep 18, 2023
@jreidinger jreidinger deleted the questions_documentation branch September 18, 2023 11:24
@imobachgs imobachgs mentioned this pull request Sep 26, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mvidner mvidner mvidner approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@jreidinger @coveralls @mvidner